home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3w / ufmGetTransformedBitmap.z / ufmGetTransformedBitmap
Encoding:
Text File  |  2002-10-03  |  11.0 KB  |  133 lines
  1.  
  2.  
  3.  
  4. uuuuffffmmmmGGGGeeeettttTTTTrrrraaaannnnssssffffoooorrrrmmmmeeeeddddBBBBiiiittttmmmmaaaapppp((((3333wwww))))                        uuuuffffmmmmGGGGeeeettttTTTTrrrraaaannnnssssffffoooorrrrmmmmeeeeddddBBBBiiiittttmmmmaaaapppp((((3333wwww))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _uuuu_ffff_mmmm_GGGG_eeee_tttt_TTTT_rrrr_aaaa_nnnn_ssss_ffff_oooo_rrrr_mmmm_eeee_dddd_BBBB_iiii_tttt_mmmm_aaaa_pppp - get a transformed character bitmap
  10.  
  11. CCCC SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_uuuu_ffff_mmmm_...._hhhh_>>>>
  13.  
  14.      _iiii_nnnn_tttt _uuuu_ffff_mmmm_GGGG_eeee_tttt_TTTT_rrrr_aaaa_nnnn_ssss_ffff_oooo_rrrr_mmmm_eeee_dddd_BBBB_iiii_tttt_mmmm_aaaa_pppp_((((_uuuu_nnnn_ssss_iiii_gggg_nnnn_eeee_dddd _iiii_nnnn_tttt _nnnn_TTTT_yyyy_pppp_eeee_ffff_aaaa_cccc_eeee_HHHH_aaaa_nnnn_dddd_llll_eeee_ssss_,,,,
  15.           _uuuu_nnnn_ssss_iiii_gggg_nnnn_eeee_dddd _iiii_nnnn_tttt _****_tttt_yyyy_pppp_eeee_ffff_aaaa_cccc_eeee_HHHH_aaaa_nnnn_dddd_llll_eeee_ssss_,,,, _iiii_nnnn_tttt _cccc_hhhh_aaaa_rrrr_CCCC_oooo_dddd_eeee_TTTT_yyyy_pppp_eeee_,,,,
  16.           _uuuu_nnnn_ssss_iiii_gggg_nnnn_eeee_dddd _iiii_nnnn_tttt _nnnn_CCCC_hhhh_aaaa_rrrr_CCCC_oooo_dddd_eeee_ssss_,,,, _vvvv_oooo_iiii_dddd _****_cccc_hhhh_aaaa_rrrr_CCCC_oooo_dddd_eeee_ssss_,,,, _ffff_llll_oooo_aaaa_tttt _tttt_rrrr_aaaa_nnnn_ssss_ffff_MMMM_aaaa_tttt_rrrr_iiii_xxxx_[[[[_4444_]]]]_,,,,
  17.           _uuuu_nnnn_ssss_iiii_gggg_nnnn_eeee_dddd _iiii_nnnn_tttt _****_nnnn_CCCC_hhhh_aaaa_rrrr_BBBB_iiii_tttt_mmmm_aaaa_pppp_ssss_,,,, _uuuu_ffff_mmmm_BBBB_iiii_tttt_mmmm_aaaa_pppp _****_****_cccc_hhhh_aaaa_rrrr_BBBB_iiii_tttt_mmmm_aaaa_pppp_ssss_))))
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      _uuuu_ffff_mmmm_GGGG_eeee_tttt_TTTT_rrrr_aaaa_nnnn_ssss_ffff_oooo_rrrr_mmmm_eeee_dddd_BBBB_iiii_tttt_mmmm_aaaa_pppp gets transformed bitmaps for specified
  21.      characters. You can get a character bitmap only for those typefaces for
  22.      which bitmap or outline font files were found, that is, those typefaces
  23.      which have the bit _u_f_m_T_y_p_e_f_a_c_e_B_i_t_m_a_p_s set to 1 in their data structures
  24.      of the type _u_f_m_T_y_p_e_f_a_c_e.
  25.  
  26.      _n_T_y_p_e_f_a_c_e_H_a_n_d_l_e_s specifies the number of entries (typeface handles) in
  27.      the array _t_y_p_e_f_a_c_e_H_a_n_d_l_e_s.
  28.  
  29.      _t_y_p_e_f_a_c_e_H_a_n_d_l_e_s specifies one or more handles for open typefaces.  Use
  30.      the function _uuuu_ffff_mmmm_OOOO_pppp_eeee_nnnn_TTTT_yyyy_pppp_eeee_ffff_aaaa_cccc_eeee to open a typeface, and get a handle for
  31.      that typeface.
  32.  
  33.      If you specify more than one typeface handle, _uuuu_ffff_mmmm_GGGG_eeee_tttt_TTTT_rrrr_aaaa_nnnn_ssss_ffff_oooo_rrrr_mmmm_eeee_dddd_BBBB_iiii_tttt_mmmm_aaaa_pppp
  34.      will look for bitmap fonts of the size _p_i_x_e_l_S_i_z_e in specified typefaces.
  35.      If it does not find a requested bitmap font, it will create it.  Then it
  36.      will look for the bitmap of a specified character in the bitmap font for
  37.      the first specified typeface.  If it does not find it in that font, it
  38.      will look for that bitmap in the next bitmap font.  It will stop looking
  39.      as soon as it finds the requested character bitmap.  If it cannot find
  40.      that bitmap, it will return the bitmap for the default character.  If
  41.      _uuuu_ffff_mmmm_GGGG_eeee_tttt_TTTT_rrrr_aaaa_nnnn_ssss_ffff_oooo_rrrr_mmmm_eeee_dddd_BBBB_iiii_tttt_mmmm_aaaa_pppp cannot find the bitmap even for the default
  42.      character, it will return an error code.
  43.  
  44.      _c_h_a_r_C_o_d_e_T_y_p_e specifies a 1-byte character code (_U_F_M__B_Y_T_E_1), a Unicode
  45.      UCS-2 code (_U_F_M__U_C_S_2), a Unicode UCS-4 code (_U_F_M__U_C_S_4), a 2-byte
  46.      character code (_U_F_M__B_Y_T_E_2), or a 4-byte character code (_U_F_M__B_Y_T_E_4).
  47.  
  48.      _n_C_h_a_r_C_o_d_e_s specifies the number of elements in the array _c_h_a_r_C_o_d_e_s.  Set
  49.      _n_C_h_a_r_C_o_d_e_s to 0 if you want bitmaps for all characters in a specified
  50.      typeface.  If you want bitmaps for only some characters, use the array
  51.      _c_h_a_r_C_o_d_e_s to specify the character codes of those characters.
  52.  
  53.      _t_r_a_n_s_f_M_a_t_r_i_x specifies a 4-element transformation matrix that needs to be
  54.      applied to character bitmaps. This is a column-major matrix. Specify
  55.      matrix elements in the following sequence: 00, 10, 01 and 11.
  56.  
  57.      _uuuu_ffff_mmmm_GGGG_eeee_tttt_TTTT_rrrr_aaaa_nnnn_ssss_ffff_oooo_rrrr_mmmm_eeee_dddd_BBBB_iiii_tttt_mmmm_aaaa_pppp returns the number of character bitmaps it finds
  58.      (_n_C_h_a_r_B_i_t_m_a_p_s) and the address of the array in which it stores those
  59.      character bitmaps (_u_f_m_B_i_t_m_a_p).
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. uuuuffffmmmmGGGGeeeettttTTTTrrrraaaannnnssssffffoooorrrrmmmmeeeeddddBBBBiiiittttmmmmaaaapppp((((3333wwww))))                        uuuuffffmmmmGGGGeeeettttTTTTrrrraaaannnnssssffffoooorrrrmmmmeeeeddddBBBBiiiittttmmmmaaaapppp((((3333wwww))))
  71.  
  72.  
  73.  
  74.      When you are finished with the array (_u_f_m_B_i_t_m_a_p), you can free it by
  75.      calling _uuuu_ffff_mmmm_FFFF_rrrr_eeee_eeee_BBBB_iiii_tttt_mmmm_aaaa_pppp with the argument values that were returned by
  76.      _uuuu_ffff_mmmm_GGGG_eeee_tttt_TTTT_rrrr_aaaa_nnnn_ssss_ffff_oooo_rrrr_mmmm_eeee_dddd_BBBB_iiii_tttt_mmmm_aaaa_pppp.
  77.  
  78.      A bitmap image provided by the function _uuuu_ffff_mmmm_GGGG_eeee_tttt_TTTT_rrrr_aaaa_nnnn_ssss_ffff_oooo_rrrr_mmmm_eeee_dddd_BBBB_iiii_tttt_mmmm_aaaa_pppp should be
  79.      interpreted the same way as image data for the OpenGL function
  80.      _gggg_llll_DDDD_rrrr_aaaa_wwww_PPPP_iiii_xxxx_eeee_llll_ssss, with width and height corresponding to the width and height
  81.      arguments in that function, and with type set to _GGGG_LLLL______BBBB_IIII_TTTT_MMMM_AAAA_PPPP and format set
  82.      to _GGGG_LLLL______CCCC_OOOO_LLLL_OOOO_RRRR______IIII_NNNN_DDDD_EEEE_XXXX.
  83.  
  84.      Each row of the bitmap is padded to a 4-byte boundary.  If you want to
  85.      use the information provided by _uuuu_ffff_mmmm_GGGG_eeee_tttt_TTTT_rrrr_aaaa_nnnn_ssss_ffff_oooo_rrrr_mmmm_eeee_dddd_BBBB_iiii_tttt_mmmm_aaaa_pppp to create OpenGL
  86.      font display lists, that is, to call OpenGL functions _gggg_llll_NNNN_eeee_wwww_LLLL_iiii_ssss_tttt,
  87.      _gggg_llll_BBBB_iiii_tttt_mmmm_aaaa_pppp, and _gggg_llll_EEEE_nnnn_dddd_LLLL_iiii_ssss_tttt, you should start by calling _gggg_llll_PPPP_iiii_xxxx_eeee_llll_SSSS_tttt_oooo_rrrr_eeee
  88.      function with the arguments _GGGG_LLLL______UUUU_NNNN_PPPP_AAAA_CCCC_KKKK______AAAA_LLLL_IIII_GGGG_NNNN_MMMM_EEEE_NNNN_TTTT and 4.  For example, if
  89.      you decide to use the function _gggg_llll_PPPP_iiii_xxxx_eeee_llll_SSSS_tttt_oooo_rrrr_eeee_iiii, you should specify
  90.      _gggg_llll_PPPP_iiii_xxxx_eeee_llll_SSSS_tttt_oooo_rrrr_eeee_iiii_((((_GGGG_LLLL______UUUU_NNNN_PPPP_AAAA_CCCC_KKKK______AAAA_LLLL_IIII_GGGG_NNNN_MMMM_EEEE_NNNN_TTTT_,,,, _4444_)))).
  91.  
  92. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  93.      ufmFreeBitmap(3w) and ufmGetBitmap(3w).
  94.  
  95. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  96.      If _uuuu_ffff_mmmm_GGGG_eeee_tttt_TTTT_rrrr_aaaa_nnnn_ssss_ffff_oooo_rrrr_mmmm_eeee_dddd_BBBB_iiii_tttt_mmmm_aaaa_pppp is not able to allocate the memory it needs,
  97.      it will return the value _UUUU_FFFF_MMMM______OOOO_UUUU_TTTT______OOOO_FFFF______MMMM_EEEE_MMMM_OOOO_RRRR_YYYY.  If the values of one or more
  98.      arguments are not valid, _uuuu_ffff_mmmm_GGGG_eeee_tttt_TTTT_rrrr_aaaa_nnnn_ssss_ffff_oooo_rrrr_mmmm_eeee_dddd_BBBB_iiii_tttt_mmmm_aaaa_pppp will return the value
  99.      _UUUU_FFFF_MMMM______IIII_NNNN_VVVV_AAAA_LLLL_IIII_DDDD______VVVV_AAAA_LLLL_UUUU_EEEE.  _UUUU_FFFF_MMMM______OOOO_UUUU_TTTT______OOOO_FFFF______MMMM_EEEE_MMMM_OOOO_RRRR_YYYY and _UUUU_FFFF_MMMM______IIII_NNNN_VVVV_AAAA_LLLL_IIII_DDDD______VVVV_AAAA_LLLL_UUUU_EEEE are defined
  100.      in the header file <_u_f_m._h>.
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.